17.1.11 MyID Core API

The MyID Core API was first added in MyID 11.6, initially to provide connectivity and functionality between the MyID Operator Client and the MyID application server. The API is used to facilitate the migration away from older user interface technologies such as ActiveX and Internet Explorer.

This API is now available for use directly; for example, you can use it to integrate into other business systems that provide information to MyID or to trigger credential lifecycle events.

The MyID Core API is based on REST architectural principles, and allows you to access a wide range of MyID features directly.

The API is secure by default, requiring authentication of the calling system in order to use the API and restricting access to available features and data using MyID role-based access and scope control.

You can use the API for such actions as:

• Searching and retrieving information about a person, device or request.

• Adding or updating a person’s information in MyID.

• Managing the lifecycle of people, devices, and requests.

Comprehensive API documentation is provided, including schema information to simplify integration development.

For more information on accessing the API and configuring its authentication, see the MyID Core API document.